聊聊如何运用JAVA注解处理器(APT)

您所在的位置:网站首页 post Errorgetaddrinfo 聊聊如何运用JAVA注解处理器(APT)

聊聊如何运用JAVA注解处理器(APT)

#聊聊如何运用JAVA注解处理器(APT)| 来源: 网络整理| 查看: 265

什么是APT

APT(Annotation Processing Tool)它是Java编译期注解处理器,它可以让开发人员在编译期对注解进行处理,通过APT可以获取到注解和被注解对象的相关信息,并根据这些信息在编译期按我们的需求生成java代码模板或者配置文件(比如SPI文件或者spring.fatories)等。APT获取注解及生成代码都是在代码编译时候完成的,相比反射在运行时处理注解大大提高了程序性能

APT的工作流程

什么是注解

:因为APT = 注解+ 注解处理器(AbstractProcessor)。因此需要了解什么是注解,不过对于java开发人员来说,注解应该是耳熟能详了,这边就不再论述。如果不了解啥是注解的小伙伴,可以查看如下文章科普一下

https://baike.baidu.com/item/%E6%B3%A8%E8%A7%A3/22344968

这边得特别说下元注解@Retention

因为APT是在java编译器使用,因此@Retention的value通常指定为source或者class,这样可以提高一点性能。就我个人而言,我倾向指定为source

APT之Element常用元素以及Element元素常用变量1、常用元素

这些元素映射到java,我通过一个例子大家应该就可以了解这些元素是指什么

2、Element元素常用变量

更多element详细内容可以查看如下链接

https://www.jianshu.com/p/899063e8452e

创建注解处理器步骤创建注解类创建一个继承自 AbstractProcessor 的类,这就是 APT 的核心类注册处理器创建注解处理器示例

注: 示例要实现的功能,通过一个自定义注解AutoComponent,通过注解处理器扫描解析AutoComponent注解,并生成lybgeek.components,spring通过解析lybgeek.components,实现bean注册

1、创建注解类@Documented @Retention(RetentionPolicy.SOURCE) @Target(ElementType.TYPE) public @interface AutoComponent { }2、创建一个继承自 AbstractProcessor 的类

这边需介绍这个类里面几个核心的方法

public synchronized void init(ProcessingEnvironment processingEnv)

init方法可以让我们处理器的初始化阶段,通过ProcessingEnvironment来获取一些帮助我们来处理注解的工具类

// Element操作类,用来处理Element的工具 Elements elementUtils = processingEnv.getElementUtils(); // 类信息工具类,用来处理TypeMirror的工具 Types typeUtils = processingEnv.getTypeUtils(); // 日志工具类,因为在process()中不能抛出一个异常,那会使运行注解处理器的JVM崩溃。所以Messager提供给注解处理器一个报告错误、警告以及提示信息的途径,用来写一些信息给使用此注解器的第三方开发者看 Messager messager = processingEnv.getMessager(); // 文件工具类,常用来读取或者写资源文件 Filer filer = environment.getFiler(); public Set getSupportedAnnotationTypes()

getSupportedAnnotationTypes方法用来指定需要处理的注解集合,返回的集合元素需要是注解全路径(包名+类名)

public SourceVersion getSupportedSourceVersion()

getSupportedSourceVersion方法用来指定当前正在使用的Java版本,一般返回SourceVersion.latestSupported()表示最新的java版本即可

public boolean process(Set


【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3